feat(sdk/go)!: replace positional labels with functional Create options - #3198
Open
rhuss wants to merge 1 commit into
Open
feat(sdk/go)!: replace positional labels with functional Create options#3198rhuss wants to merge 1 commit into
rhuss wants to merge 1 commit into
Conversation
rhuss
requested review from
a team,
derekwaynecarr,
mrunalp and
sjenning
as code owners
September 5, 2026 06:46
rhuss
force-pushed
the
6117-go-sdk-create-options
branch
2 times, most recently
from
September 5, 2026 13:29
4d0ad25 to
ee2edef
Compare
Move labels and annotations from separate parameter positions into
functional options (WithLabels, WithAnnotations) on Create() and
CreateFromTemplate().
Before: Create(ctx, ws, name, spec, labels, CreateOptions{Annotations: ann})
After: Create(ctx, ws, name, spec, WithLabels(labels), WithAnnotations(ann))
This unifies two resource metadata fields that were inconsistently
placed (labels as positional, annotations in a struct) into a single
extensible options pattern matching the existing LogOption convention.
BREAKING CHANGE: Create() and CreateFromTemplate() signatures changed.
All callers must use WithLabels() and WithAnnotations() functional
options instead of positional labels and CreateOptions struct.
Closes NVIDIA#2807
Signed-off-by: Roland Huß <rhuss@redhat.com>
rhuss
force-pushed
the
6117-go-sdk-create-options
branch
from
September 5, 2026 13:30
ee2edef to
c6506d7
Compare
Contributor
Author
elezar
requested changes
Sep 7, 2026
elezar
left a comment
elezar
left a comment
Member
There was a problem hiding this comment.
Existing callers using Create(ctx, ws, name, spec, nil) for an unlabeled sandbox still compile after this API change: nil is a valid CreateOption value. ApplyCreateOptions then invokes that nil function and panics at runtime. Please ignore nil options in ApplyCreateOptions (and add a regression test covering the legacy trailing-nil call) so this migration remains safe for existing consumers.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Unify the inconsistent treatment of
labels(positional parameter) andannotations(CreateOptionsstruct field) by moving both into functional options onSandboxInterface.Create().Before:
After:
Related Issue: Closes #2807
Changes
CreateOptionfunctional option type following the existingLogOptionpatternWithLabels()andWithAnnotations()option functionsCreateOptionsstruct (clean break, SDK is pre-1.0)SandboxInterface.Create()signatureTesting
go test ./...)go build ./...andgo vet ./...cleanChecklist